/*
 * Copyright 2010-2012 Susanta Tewari. <freecode4susant@users.sourceforge.net>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package bd.org.apache.commons.math.linear;

import bd.org.apache.commons.math.exception.NumberIsTooSmallException;
import bd.org.apache.commons.math.exception.util.ExceptionContext;
import bd.org.apache.commons.math.exception.util.LocalizedFormats;

/**
 * Exception to be thrown when a positive definite matrix is expected.
 *
 * @version $Id: NonPositiveDefiniteMatrixException.java 1244107 2012-02-14 16:17:55Z erans $
 * @since 3.0
 */
public class NonPositiveDefiniteMatrixException extends NumberIsTooSmallException {

    /**
     * Serializable version Id.
     */
    private static final long serialVersionUID = 1641613838113738061L;

    /**
     * Index (diagonal element).
     */
    private final int index;

    /**
     * Threshold.
     */
    private final double threshold;

    /**
     * Construct an exception.
     *
     * @param wrong Value that fails the positivity check.
     * @param index Row (and column) index.
     * @param threshold Absolute positivity threshold.
     */
    public NonPositiveDefiniteMatrixException(double wrong, int index, double threshold) {

        super(wrong, threshold, false);

        this.index     = index;
        this.threshold = threshold;

        final ExceptionContext context = getContext();

        context.addMessage(LocalizedFormats.NOT_POSITIVE_DEFINITE_MATRIX);
        context.addMessage(LocalizedFormats.ARRAY_ELEMENT, wrong, index);
    }

    /**
     * @return the row index.
     */
    public int getRow() {

        return index;
    }


    /**
     * @return the column index.
     */
    public int getColumn() {

        return index;
    }


    /**
     * @return the absolute positivity threshold.
     */
    public double getThreshold() {

        return threshold;
    }
}
